home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / COMMUNIC / COMMUTIL / 2258.ZIP / EZEVNT35.ZIP / EAZEVNT3.DOC < prev    next >
Text File  |  1990-04-04  |  14KB  |  311 lines
  1.              EAZEVNT3.EXE V3.55 - Produces lists of Today's Events
  2.              -----------------------------------------------------
  3.              for use with EaziLink Version 3 Host Mode/EaziHost V1
  4.  
  5.      4th April 1990
  6.  
  7.      Disclaimer
  8.      ----------
  9.  
  10.      This program is being put  into  the  Public  Domain and may be freely
  11.      distributed  on  the  understanding  that  no  responsibility  can  be
  12.      accepted for any problems arising  from  its  use.  To the best of our
  13.      knowledge, it is 'Bug free' and serves its intended purpose.
  14.  
  15.      No charge, other than a nominal charge for duplication and postage may
  16.      be made for it and it should only be supplied as a single ARC, PAK, or
  17.      ZIP file called EZEVNT35.ARC,  EZEVNT35.PAK, or EZEVNT3.ZIP containing
  18.      the EAZEVNT3.EXE and EAZEVNT3.DOC files.
  19.  
  20.  
  21.      Origins
  22.      -------
  23.  
  24.      This program was inspired by a  program called TODAY, which is readily
  25.      found on Bulletin Boards throughout the country.
  26.  
  27.      TODAY was written in 'C' by Patrick Kincaid in 1986 and was apparently
  28.      inspired by a program originally written by  Mike Butler in PL/1 on an
  29.      IBM VM/CMS system.
  30.  
  31.      Whilst TODAY may be made to send output to a file on disk by using MS-
  32.      DOS re-direction, the copyright  message  is  always displayed and the
  33.      user has no control over the various headings.
  34.  
  35.      EazEvnt3 is written  with  TopSpeed  (JPI)  Modula  2  specifically to
  36.      overcome these shortcomings and whilst  it  can  be  used from the DOS
  37.      command line or a  batch  file,  this  particular version is primarily
  38.      intended to produce output suitable  for  display either as a message,
  39.      bulletin, Log On, or Log Off message.
  40.  
  41.      The program has been written to  be file compatible with the TODAY.???
  42.      data files  supplied  with  the  TODAY  program,  but  with  one extra
  43.      feature. This means  that  TODAY  data  files  may  be  used. The only
  44.      disadvantage to this is  that  many  of  the  dates relate to American
  45.      events or people.
  46.  
  47.      The TODAY data files are very American  and users may prefer to either
  48.      create their own data files, or delete some of the more obscure events
  49.      and dates from the TODAY.??? files before using them!
  50.  
  51.  
  52.      Overview
  53.      --------
  54.  
  55.      The program generates a file containing  lists of birthdays and events
  56.      related to the current  date.  It  will  also  include 'Reminders' and
  57.      'Once Only' dates (These are explained later).
  58.  
  59.      The prime object of the program is  to produce output suitable for use
  60.      on a Bulletin Board. Many BBs provide  a  'Quote for the day'. This is
  61.      an alternative! Fairly pointless,  but  interesting  and the reminders
  62.      can be very useful.
  63.  
  64.  
  65.      Running EAZEVNT3
  66.      ----------------
  67.  
  68.      EazEvnt3 should be located in a directory with all its data files. The
  69.      data files must be called  DATES.JAN,  DATES.FEB,  DATES.MAR etc and a
  70.      special file called DATES.OWN may also  be included (This is described
  71.      later). If you are using the TODAY data files, copy them into the same
  72.      directory and then rename them using:-
  73.  
  74.           REN  TODAY.*  DATES.*
  75.  
  76.      By default, EAZEVNT3 will only run  once  every day, although this can
  77.      be overridden (usually only required  for  test purposes) by adding an
  78.      optional command line parameter (described later).
  79.  
  80.      The program would normally be run from  a  batch file at some stage in
  81.      the cycling of the Bulletin Board.  The  batch file MUST change DOS to
  82.      the directory containing the EAZEVNT3.EXE  file  before the program is
  83.      run. The command syntax is:-
  84.  
  85.         EAZEVNT3 <outfile> (/E)
  86.  
  87.      <outfile> is the name  of  the  file  to  receive  the  output and may
  88.                include drive and path names.
  89.  
  90.      /E        is optional, but if used  will  result  in the program being
  91.                executed every time.
  92.  
  93.  
  94.      When the program is  executed,  it  gets  the  current  date  from the
  95.      computer's system clock and compares this  with the date/time stamp of
  96.      the EAZEVNT3.EXE file.  The  program  then  updates  the  date  of the
  97.      EAZEVNT3.EXE file to the current time and date.
  98.  
  99.      If the system and file  dates  (not  times)  are the same, the program
  100.      then terminates, otherwise it looks for a data file called DATES, with
  101.      an extension the same as the  first  three  letters of the month (JAN,
  102.      FEB, MAR etc) and searches the  data  file for matching dates. It also
  103.      looks for a data file called  DATES.OWN  and checks the dates in that.
  104.      DATES.OWN is convenient as a means of  adding your own dates, or dates
  105.      which may need changing periodically, such as the dates of Easter etc.
  106.  
  107.      EazEvnt3 also attempts to find  a  file called EAZEVNT3.CNF. If found,
  108.      it uses the contents of this  file  as  the  headers for each group of
  109.      dates, but if it  is  not  found,  it  uses  its  own default headings
  110.      instead. The advantage of using the CNF files is that it allows you to
  111.      insert colour into the file in the form of EaziLink pseudo ansi codes.
  112.  
  113.      The data is then written out  to  the  specified output file which may
  114.      then be used by the BB however it wishes.
  115.  
  116.      Note: A maximum of 10  Birthdays,  10  Special Events and 10 Reminders
  117.      will be written out to the file,  in  order to keep it to a reasonable
  118.      size. This should not normally be a restriction.
  119.  
  120.  
  121.      Data File Format
  122.      ----------------
  123.  
  124.      The format of the data files is compatible with that used by the TODAY
  125.      program, but also includes an extra  option.  The data files are plain
  126.      ASCII and may be edited with any ASCII text editor.
  127.  
  128.      Each data file must  be  called  DATES.???   where  '???' is the first
  129.      three characters of the month (in English!),  or may be a special file
  130.      called DATES.OWN, which is primarily intended as a convenient means of
  131.      storing personal dates or those which may need changing periodically.
  132.  
  133.      With the exception of DATES.OWN, which  may contain dates for any time
  134.      in any year, each of the  other  data  files should only contain dates
  135.      relating to that month.
  136.  
  137.      The format of the files is straightforward:-
  138.  
  139.      Any line starting with an asterisk '*'  in  column one is treated as a
  140.      'comment' line and is not processed.
  141.  
  142.      Column 1:   The record type which can be a
  143.  
  144.                  B   -  for birthdays.
  145.                  S   -  for special dates in history.
  146.                  R   -  for a reminder.
  147.  
  148.      Cols 2-3:   Month, followed by Day with leading zeros for each, in the
  149.                  form MMDD. Zeros will cause ALL months to match when being
  150.                  scanned. For example 0001  will  match  the first of every
  151.                  month while 0400 would match every day of April.
  152.  
  153.                  Note: Due to  maintaining  compatibility  with  TODAY data
  154.                  files, the dates  are  in  the  American  format of Month,
  155.                  followed by Day.
  156.  
  157.      Cols 6-9:   The full year of the event  as four digits, or spaces. The
  158.                  entry may be left blank.
  159.  
  160.      Column 10:  A special processing flag. Values may be:
  161.  
  162.                  BLANK for no special processing.
  163.  
  164.                  C  - to continue a  message  from the previous line. Note,
  165.                  that you MUST repeat the date fields in every continuation
  166.                  line. Only the text will actually be displayed however.
  167.  
  168.                  DAY-OF-WEEK DIGIT  -  where  1=Sunday  ...  7=Saturday. If
  169.                  used, the message will only be  included if the day of the
  170.                  week is the same as specified by this digit. This provides
  171.                  a  mechanism  to  display  occasions   which  occur  on  a
  172.                  specified day of the week, on  or around a given date. See
  173.                  examples below.
  174.  
  175.                  O  - (Letter 'O', not zero) is an addition to the original
  176.                  TODAY format and  will  result  in  the  message only ever
  177.                  being displayed once, on  the  precise  day, date and year
  178.                  specified. You might choose to use it on 01012000 (January
  179.                  1st 2000)  to  wish  everyone  a  Happy  New  Century, for
  180.                  example.
  181.  
  182.      Cols 11-79  The message to be displayed for this date.
  183.  
  184.  
  185.      Examples of Data File Entries
  186.      -----------------------------
  187.  
  188.      * Examples of Birthday entries.
  189.      B02221945 David Foster. Author of this program.
  190.      B03011810 Frederic Chopin
  191.      * Examples of Special Events.
  192.      S03051979 Voyager I flies past Jupiter.
  193.      S03101876 the 1st telephone call made by Alexander Graham Bell
  194.      * The following includes two 'continuation lines'.
  195.      S03011864 patent issued for taking & projecting motion pictures to
  196.      S03011864CLouis Ducos du Hauron (he never did build such a
  197.      S03011864Cmachine, though).
  198.      * Example of a few Reminders.
  199.      * The first two will display every day in the appropriate month.
  200.      * The third will display on the 1st of every month.
  201.      R1200     It's not long to Christmas now!
  202.      R0400     Don't forget the Tax Return soon!
  203.      R0001     Another New Month.
  204.      * Example of a 'once only' Reminder.
  205.      S01012000OWelcome to the New Century.
  206.      * Examples of using the Day-of-Week Digits
  207.      * Each date is only valid if it is a Monday (2) and as the Bank
  208.      * Holiday is always the last Monday in the month, the correct date
  209.      * will always be displayed.
  210.      *
  211.      S0525    2Spring Bank Holiday Monday
  212.      S0526    2Spring Bank Holiday Monday
  213.      S0527    2Spring Bank Holiday Monday
  214.      S0528    2Spring Bank Holiday Monday
  215.      S0529    2Spring Bank Holiday Monday
  216.      S0530    2Spring Bank Holiday Monday
  217.      S0531    2Spring Bank Holiday Monday
  218.      * A reminder, using the Day-of-Week digit.
  219.      R0013    6Watch out! It's Friday the 13th!
  220.  
  221.  
  222.      The Configuration File
  223.      ----------------------
  224.  
  225.      The EAZEVNT3.CNF file is optional,  but  may  be used to customise the
  226.      headings which precede Birthdays, Special Event and Reminders.
  227.  
  228.      If created, the CNF file must contain exactly three lines.
  229.  
  230.      Line 1 contains the Message to precede the list of Birthdays
  231.      Line 2 contains the Message to precede the list of Special Events
  232.      Line 3 contains the Message to precede the list of Reminders
  233.  
  234.      Each line may  also  include  EaziLink/EaziHost  Pseudo-ANSI  codes to
  235.      provide colours and effects, as required. If a colour is not cancelled
  236.      at the end of the line with ^C0,  it will be used for all the entries,
  237.      unless changed by the next heading.
  238.  
  239.      Two special variables may be used. These are:-
  240.  
  241.          %YEAR    - produces the year, according to the system clock.
  242.          %DATE    - produces the date, according  to  the  system clock, in
  243.                     the form '30th November' or '21st October'
  244.  
  245.      The variables may be used in any  of  the  three lines in the CNF file
  246.      and the results will be substituted when the file is created.
  247.  
  248.      A sample EAZEVNT3.CNF file is included.
  249.  
  250.  
  251.      Example of a Batch File to use EazEvnt3
  252.      ---------------------------------------
  253.  
  254.      The following example is called RECYCLE.BAT  and is run by EaziLink or
  255.      EaziHost every time they recycle after a caller. The only disadvantage
  256.      to this is that the first caller each day will receive the information
  257.      for the previous day as  the  program  will  not have recycled at that
  258.      point.
  259.  
  260.      EaziHost includes  the  provision  to  run  a  batch  file  using  the
  261.      ENTRY1.HST door mechanism and this can  be  used to run the batch file
  262.      as soon as a caller logs  on.  EazEvnt3  will only create the file the
  263.      first time a caller logs on in  the  new  day and it will be available
  264.      for display as soon as they have  logged on. This is not possible with
  265.      EaziLink Host Mode, unfortunately.
  266.  
  267.         ECHO OFF
  268.         REM RECYCLE.BAT is used to run processes during a re-cycle sequence
  269.         CD \DATA
  270.         EAZEVNT3 \EAZILINK\HOSTMAIN\LOGOFF.HST
  271.  
  272.      In the above batch  file,  the  directory  is  changed to DATES, which
  273.      contains all the EazEvnt3 files and the program is executed, directing
  274.      the output to  a  file  called  LOGOFF.HST  in the \EAZILINK\HOSTMAIN\
  275.      directory. LOGOFF.HST is  the  file  which  is automatically displayed
  276.      whenever anyone logs off EaziLink or EaziHost.
  277.  
  278.  
  279.      Update History
  280.      --------------
  281.  
  282.      The range of EAZ????? utilities for use with EaziLink and now EaziHost
  283.      share a common form of Version numbering.
  284.  
  285.      Programs with Version numbers lower  that  V3.00  were written to work
  286.      with EaziLink V1 or V2.
  287.      Programs with version numbers V3.?? up  to  V3.49 were written for use
  288.      with EaziLink V3.
  289.      Programs with version numbers 3.5? or  higher will work with both with
  290.      EaziLink V3 and EaziHost V1.
  291.  
  292.      Version
  293.      3.50 - 15/12/89 - Initial Beta test version
  294.  
  295.      3.51 - 21/12/89 - First Release version.
  296.      3.53 - 02/01/90 - Added default  text  to  be  displayed  if  no match
  297.                        found.
  298.                      - Fixed bug which caused  problems  when month and day
  299.                        were single digits.
  300.  
  301.  
  302.      David Foster
  303.      H.L.C. Services
  304.      High Leys
  305.      Crook
  306.      Kendal
  307.      Cumbria
  308.      LA8 8LF
  309.  
  310.                                       END
  311.